packages/logger/README.md (2)

1-4: Enhance the introduction with installation instructions

The README would benefit from a dedicated "Installation" section before the "Usage" section, detailing:

• npm/yarn installation commands
• Peer dependencies (if any)
• Node.js version requirements

---

12-20: Fix package.json example syntax

The package.json example contains a syntax error and could be more complete.

Consider updating to:

{
  "dependencies": {
    "@plane/logger": "*"
  }
}

packages/logger/src/client-logger.ts (1)

31-36: Enhance error handling for transports

Currently, transport errors are logged to the console. Depending on the application's requirements, consider implementing additional error handling mechanisms such as alerting, retries, or fallback strategies to ensure robust logging.

packages/logger/src/server-logger.ts (1)

14-17: Avoid using synchronous file system methods in a server environment

Using fs.existsSync and fs.mkdirSync blocks the event loop, which can impact performance. Consider using asynchronous methods to prevent blocking.

Apply this diff to use asynchronous methods:

-if (!fs.existsSync(logDirectory)) {
-  fs.mkdirSync(logDirectory);
-  console.log('Logs folder created');
-}
+fs.access(logDirectory, fs.constants.F_OK, (err) => {
+  if (err) {
+    fs.mkdir(logDirectory, { recursive: true }, (err) => {
+      if (err) {
+        console.error('Error creating logs folder:', err);
+      } else {
+        console.log('Logs folder created');
+      }
+    });
+  }
+});

packages/logger/src/logger.ts (1)

17-17: Remove debugging console.log statement

The console.log("inside client logger import") statement appears to be for debugging purposes. It may be unnecessary in production code and could clutter the console output.

Apply this diff to remove the debug statement:

-  console.log("inside client logger import");

Configuration used: CodeRabbit UI
Review profile: CHILL

#!/bin/bash
# Check versioning pattern of other @plane/* dependencies
rg '"@plane/[^"]+": "[^"]+"' web/package.json

packages/logger/README.md (2)

27-27: Fix Markdown formatting for the heading

There is no blank line between the code block and the heading at line 27, which may cause rendering issues. Please add a blank line between the code block and the heading.

Apply this diff:

 }
+```

 ### `logger`: General Logger
 Use this for general application logs.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~27-~27: Loose punctuation mark.
Context: ... from "@plane/logger"; ``` ### logger: General Logger Use this for general app...

(UNLIKELY_OPENING_PUNCTUATION)

---

58-58: Add missing article "an"

Line 58 is missing the article "an" before "optional". It should read "by passing an optional logLevel param".

Apply this diff:

- You can specify a log level during the first import of logger by passing optional logLevel param in getLogger function.
+ You can specify a log level during the first import of the logger by passing an optional `logLevel` param in the `getLogger` function.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~58-~58: You might be missing the article “an” here.
Context: ...g the first import of logger by passing optional logLevel param in getLogger function.

(AI_EN_LECTOR_MISSING_DETERMINER_AN)

packages/logger/src/server-logger.ts (1)

15-18: Avoid synchronous file system operations

Using synchronous file system methods like fs.existsSync and fs.mkdirSync can block the event loop and impact performance. Consider using asynchronous methods instead.

Apply this diff:

-if (!fs.existsSync(logDirectory)) {
-  fs.mkdirSync(logDirectory);
-  console.log('Logs folder created');
-}
+fs.promises.mkdir(logDirectory, { recursive: true })
+  .then(() => console.log('Logs folder created'))
+  .catch((err) => {
+    if (err.code !== 'EEXIST') {
+      console.error('Error creating logs folder:', err);
+    }
+  });

Ensure that any code depending on the existence of the log directory accounts for the asynchronous nature of this operation.

packages/logger/tsconfig.json (1)

4-6: Consider using a more conservative target for better compatibility.

While using ESNext for both module and target provides access to the latest features, it might limit compatibility with older Node.js versions. Consider using explicit versions (e.g., ES2020) based on your minimum supported Node.js version.

-    "module": "ESNext",
-    "target": "ESNext",
+    "module": "ES2020",
+    "target": "ES2020",

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

 public static getLogger(loggerOptions?: ILoggerOptions): IClientLogMethods {
-    const instance = ClientLogger.getInstance(loggerOptions);
+    const instance = ClientLogger.getInstance();
+    if (loggerOptions?.logLevel && loggerOptions.logLevel !== instance.logLevel) {
+        instance.logLevel = loggerOptions.logLevel;
+    }
     return instance.logMethods;
 }

 private static getInstance() {
     if (!Logger.instance) {
         Logger.instance = new Logger();
     }
     return Logger.instance;
 }

 public static getLogger(loggerOptions?: ILoggerOptions) {
     const instance = Logger.getInstance();
+    if (loggerOptions?.logLevel && loggerOptions.logLevel !== instance.logLevel) {
+        instance.logger.level = loggerOptions.logLevel;
+        instance.logLevel = loggerOptions.logLevel;
+    }
+    if (loggerOptions?.logFilePrefix && loggerOptions.logFilePrefix !== instance.logFilePrefix) {
+        // Logic to update the logFilePrefix
+        instance.logFilePrefix = loggerOptions.logFilePrefix;
+        // Reconfigure transports as necessary
+    }
     return instance.logger;
 }

#!/bin/bash
# Description: Verify the existence and content of the base TypeScript configuration

# Check if the base config exists
fd -t f "base.json" -p "@plane/typescript-config"

# If found, examine its content
fd -t f "base.json" -p "@plane/typescript-config" -x cat {}

#!/bin/bash
# Let's try different approaches to locate the TypeScript configuration
# 1. Find all tsconfig files to understand the structure
fd tsconfig

# 2. Look for any package.json that might reference typescript-config
fd "package.json" -x grep -l "typescript-config"

# 3. Search for base.json in the entire repository
fd "base.json"

#!/bin/bash
# Let's examine the base.json content and verify it's properly configured
cat packages/typescript-config/base.json

# Also check the package.json of typescript-config to understand its setup
cat packages/typescript-config/package.json

#!/bin/bash
# Description: Look for build configuration files that might need path alias setup

# Search for common build config files
fd -t f "webpack.config|rollup.config|vite.config|package.json" -p "packages/logger"

# Check if path aliases are configured in package.json
fd -t f "package.json" -p "packages/logger" -x jq '.exports' {}

#!/bin/bash
# Check for build configuration in package.json and any build scripts
fd -t f "package.json" -p "packages/logger" -x jq '.scripts' {}

# Look for tsconfig references in the project
fd -t f "tsconfig" -p "packages/logger"

# Check if there's any build tool configuration
fd -t f "rollup|webpack|vite|babel|esbuild" -p "packages/logger"

#!/bin/bash
# Check if there's a tsup config file
fd -t f "tsup.config" -p "packages/logger"

# Look at the actual source files to see if path aliases are being used
rg -g "*.{ts,tsx}" "from '@/" packages/logger/src

packages/logger/src/config.ts (4)

5-12: Add JSDoc comments for log levels

Consider adding JSDoc comments to document the purpose and usage of each log level. This would help other developers understand when to use each level appropriately.

 // Define log levels
+/**
+ * Log levels in order of increasing verbosity:
+ * - error: For errors that need immediate attention
+ * - warn: For potentially harmful situations
+ * - info: For general information about system operation
+ * - http: For HTTP request logging
+ * - debug: For detailed debugging information
+ */
 const levels = {

---

14-24: Add TypeScript type definitions for colors

Consider adding a type definition for the colors object to improve type safety.

+type LogColors = {
+  [K in keyof typeof levels]: string;
+};
+
 // Define colors for each level
-const colors = {
+const colors: LogColors = {
   error: "red",
   warn: "yellow",
   info: "green",
   http: "magenta",
   debug: "white",
 };

---

26-33: Consider enhancing the log format

The current format is clean but could be more informative for debugging purposes. Also, colorizing all content might interfere with log parsing tools.

 const format = winston.format.combine(
   winston.format.timestamp({ format: "YYYY-MM-DD HH:mm:ss:ms" }),
-  winston.format.colorize({ all: true }),
+  winston.format.colorize({ level: true }),
   winston.format.printf(
-    (info: winston.Logform.TransformableInfo) => `[${info?.timestamp}] ${info.level}: ${info.message}`
+    (info: winston.Logform.TransformableInfo) => `[${info?.timestamp}] ${info.level}: ${info.message}${info.stack ? '\n' + info.stack : ''}${
+      Object.keys(info).some(key => !['timestamp', 'level', 'message', 'stack'].includes(key))
+        ? '\n' + JSON.stringify(Object.assign({}, info, { timestamp: undefined, level: undefined, message: undefined, stack: undefined }))
+        : ''
+    }`
   )
 );

---

1-66: Add tests and usage documentation

Consider adding:

1. Unit tests for logger configuration
2. Integration tests for file rotation
3. Usage examples in the README
4. Documentation for available environment variables

This is a critical infrastructure component that needs thorough testing and documentation.

Would you like me to help create:

1. A test suite template?
2. Usage examples for the README?
3. Environment variables documentation?

packages/logger/src/middleware.ts (1)

1-2: Consider adding type safety for the logger interface

While the Express types are properly imported, we should ensure type safety for the logger interface to prevent potential runtime errors if the logger implementation changes.

 import { Request, Response, NextFunction } from "express";
+import type { Logger } from 'winston';
 import { logger } from "./config";

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

 export const requestLogger = (req: Request, res: Response, next: NextFunction) => {
+  try {
     // Log when the request starts
     const startTime = Date.now();
+  } catch (error) {
+    logger.error('Error in request logger middleware:', error);
+    next(error);
+  }

packages/logger/README.md (3)

5-5: Remove trailing period from heading

Remove the trailing period from the "Features" heading to follow markdown conventions.

-## Features.
+## Features

🧰 Tools

🪛 Markdownlint (0.37.0)

5-5: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

3-3: Enhance the introduction with structured logging details

Consider expanding the introduction to highlight the structured logging capabilities, including:

• JSON log format
• Correlation ID support
• Log metadata enrichment

---

55-55: Fix hyphenation in rotation period

Add a hyphen to the compound adjective.

-Log files have a 7 day rotation period defined.
+Log files have a 7-day rotation period defined.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~55-~55: When a number forms part of an adjectival compound, use a hyphen.
Context: ...mbined-%DATE%.log`. - Log files have a 7 day rotation period defined. ## Configurat...

(MISSING_HYPHEN)

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

#!/bin/bash
# Description: Verify logger implementation matches documentation

# Check if winston logger is properly configured
ast-grep --pattern 'import { createLogger } from "winston"'

# Verify log level configuration from env
ast-grep --pattern 'process.env.LOG_LEVEL'

# Check request logger middleware implementation
ast-grep --pattern $'export const requestLogger = (req: Request, res: Response, next: NextFunction) => {
  $$$
}'

#!/bin/bash
# Check the complete winston logger configuration
ast-grep --pattern $'export const logger = createLogger({
  $$$
})'

# Also check if there's a general usage export
rg -l "export.*logger" packages/logger/src/

#!/bin/bash
# Get the complete logger configuration
cat packages/logger/src/config.ts